home *** CD-ROM | disk | FTP | other *** search
/ Amiga Developer CD 2.1 / Amiga Developer CD v2.1.iso / NDK / NDK_1.3 / Autodocs1.3 / LibrariesL-Z / translator.doc < prev   
Encoding:
Text File  |  1988-10-17  |  1.3 KB  |  45 lines
  1. TABLE OF CONTENTS
  2.  
  3. translator.library/Translate
  4.  
  5.  
  6. translator.library/Translate                       translator.library/Translate
  7.  
  8.     NAME
  9.     Translate - Converts an English string into phonemes
  10.  
  11.     SYNOPSIS
  12.     rtnCode = Translate(instring, inlen, outbuf, outlen)
  13.     D0            A0          D0     A1         D1
  14.  
  15.     LONG Translate(APTR,LONG,APTR,LONG);
  16.  
  17.     FUNCTION
  18.     The translate function converts an English string into
  19.     a string of phonetic codes suitable as input to the
  20.     narrator device.  
  21.  
  22.     INPUTS
  23.     instring - pointer to English string
  24.     inlen     - length of English string
  25.     outbuf   - a char array which will hold the phonetic codes
  26.     outlen   - the length of the output array
  27.     
  28.     RESULTS
  29.     rtnCode - 
  30.         Translate will return a zero if no error has occured.
  31.         The only error that can occur is overflowing the output
  32.         buffer.  If Translate determines that an overflow will
  33.         occur, it will stop the translation at a word boundary
  34.         before the overflow happens.  If this occurs, Translate
  35.         will return a negative number whose absolute value 
  36.         indicates where in the INPUT string Translate stopped.
  37.         The user can then use the offset -rtnCode from the
  38.         beginning of the buffer in a subsequent Translate call
  39.         to continue the translation where s/he left off.
  40.     
  41.     BUGS
  42.  
  43.     SEE ALSO
  44.  
  45.